package com.wangshouyu.plugins.swagger;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author 王守钰
 * @date 2021-12-27 09:35
 * @description swagger展示枚举
 */
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface SwaggerDisplayEnum {

    /**
     * 枚举键，默认值（枚举class）
     * @return 枚举键
     */
    String key() default "";

    /**
     * 枚举值，默认值'value'
     * @return 枚举值
     */
    String value() default "value";

    /**
     * 枚举类,必须继承枚举类
     * @return 枚举类
     */
    Class<? extends Enum> clazz();
}
